[skip changelog] Document "Library Name Priority" #1301
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When multiple libraries contain files matching an `#include` directive, Arduino CLI must pick one. Multiple factors are used in order to make an intelligent determination of which library is best. In order to enhance this determination, the library.properties `name` value is now one of those factors. The other factors are already documented in the "Sketch Build Process" documentation, but this newly added feature was previously undocumented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)docs update
When multiple libraries contain files matching an
#includedirective, Arduino CLI must pick one. Multiple factors areused in order to make an intelligent determination of which library is best. In order to enhance this determination, the
library.properties
namevalue is now one of those factors (#1300). The other factors are already documented in the "Sketch Build Process" documentation, but this newly added feature was previously undocumented.The "Library Name Priority" dependency resolution factor is fully documented in the "Sketch Build Process" documentation,
titled accordingly?
No breaking
I used the "Arduino Low Power" library in the examples rather than following the convention of using the "Servo" library because I wanted to make it clear how spaces are handled.
Related: #1292